home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / lib / mozilla-firefox / idl / nsIXPTLoader.idl < prev    next >
Text File  |  2006-05-08  |  4KB  |  101 lines
  1. /* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
  2. /* ***** BEGIN LICENSE BLOCK *****
  3.  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  4.  *
  5.  * The contents of this file are subject to the Mozilla Public License Version
  6.  * 1.1 (the "License"); you may not use this file except in compliance with
  7.  * the License. You may obtain a copy of the License at
  8.  * http://www.mozilla.org/MPL/
  9.  *
  10.  * Software distributed under the License is distributed on an "AS IS" basis,
  11.  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12.  * for the specific language governing rights and limitations under the
  13.  * License.
  14.  *
  15.  * The Original Code is the external XPT loader interface.
  16.  *
  17.  * The Initial Developer of the Original Code is
  18.  * Netscape Communications Corp.
  19.  * Portions created by the Initial Developer are Copyright (C) 2002
  20.  * the Initial Developer. All Rights Reserved.
  21.  *
  22.  * Contributor(s):
  23.  *   John Bandhauer <jband@netscape.com>
  24.  *   Alec Flett <alecf@netscape.com>
  25.  *
  26.  * Alternatively, the contents of this file may be used under the terms of
  27.  * either of the GNU General Public License Version 2 or later (the "GPL"),
  28.  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  29.  * in which case the provisions of the GPL or the LGPL are applicable instead
  30.  * of those above. If you wish to allow use of your version of this file only
  31.  * under the terms of either the GPL or the LGPL, and not to allow others to
  32.  * use your version of this file under the terms of the MPL, indicate your
  33.  * decision by deleting the provisions above and replace them with the notice
  34.  * and other provisions required by the GPL or the LGPL. If you do not delete
  35.  * the provisions above, a recipient may use your version of this file under
  36.  * the terms of any one of the MPL, the GPL or the LGPL.
  37.  *
  38.  * ***** END LICENSE BLOCK ***** */
  39.  
  40.  
  41. #include "nsISupports.idl"
  42. #include "nsILocalFile.idl"
  43. #include "nsIInputStream.idl"
  44.  
  45. /**
  46.  * Implement nsIXPTLoaderSink if you want to enumerate the entries in
  47.  * an XPT archive of some kind
  48.  */
  49. [scriptable, uuid(6E48C500-8682-4730-ADD6-7DB693B9E7BA)]
  50. interface nsIXPTLoaderSink : nsISupports {
  51.     
  52.     /**
  53.      * called by the loader for each entry in the archive
  54.      * @param itemName the name of this particular item in the archive
  55.      * @param index the index of the item inthe archive
  56.      * @param stream contains the contents of the xpt file
  57.      */
  58.     void foundEntry(in string itemName,
  59.                     in long index,
  60.                     in nsIInputStream xptData);
  61. };
  62.  
  63. /**
  64.  * The XPT loader interface: implemented by a loader to grab an input
  65.  * stream which will be consumed by the interface loader.
  66.  */
  67. [scriptable, uuid(368A15D9-17A9-4c2b-AC3D-A35B3A22B876)]
  68. interface nsIXPTLoader : nsISupports {
  69.     /**
  70.      * enumerate entries in the given archive
  71.      * for each entry found, the loader will call the sink's
  72.      * foundEntry() method with the appropriate information and a
  73.      * stream that the consumer can read from
  74.      * @param file the file to read from
  75.      * @param sink an object which will be called with each file found
  76.      *             in the file
  77.      */
  78.     void enumerateEntries(in nsILocalFile file,
  79.                           in nsIXPTLoaderSink sink );
  80.  
  81.     /**
  82.      * Load a specific entry from the archive
  83.      * @param file the file to read from
  84.      * @param name the name of the xpt within the file
  85.      * @return an input stream that will read the raw xpt data from
  86.      *         the file
  87.      */
  88.     nsIInputStream loadEntry(in nsILocalFile file,
  89.                              in string name);
  90. };
  91.  
  92.  
  93. %{C++
  94.  
  95. // the first part of the contractID for any loader
  96. // append the type of loader that you need, such as "zip"
  97. #define NS_XPTLOADER_CONTRACTID_PREFIX \
  98.    "@mozilla.org/xptinfo/loader;1&type="
  99.  
  100. %}
  101.